Night Owl 6

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 029a / scc.zip / REG_LOG.SCC < prev next >

Wrap

Text File | 1991-09-11 | 30KB | 653 lines

#************************************ # # Software Change Control (SCC) # Version 2.20 09-07-91 # # Softime Systems # P.O Box 2447 # Lake Ronkonkoma LI. NY 11779 # (516) 981-8386 # # Copyright (c) 1990-91 Walter Erickson # ALL RIGHTS RESERVED # # ------------ Header ------------- # --------------------------------- # # Out LOG = reg_log.scc # type = LONG # day/month/year = 11/9/1991 # hr:min:sec = 16:32:51 # # In MASTER (old) = reg_log.v1 # lines = 266 # length = 11151 # day/month/year = 11/9/1991 # hr:min:sec = 15:58:4 # hash = 883447 # # In MASTER (new) = reg_log.v2 # lines = 412 # length = 16988 # day/month/year = 11/9/1991 # hr:min:sec = 15:58:4 # hash = 1322866 # # ------- SCC Build Options ------- # # Group Match = 6 # Log Detail = Yes # Strip End White = No # Ignore Case = Yes # Ignore White = Yes # Ignore Numbers = Yes # Ignore Strings = Yes # # -------- Ignore Strings --------- # # String 1 = "Old" # String 2 = "New" # String 3 = "SCC" # String 4 = "CSS" # String 5 = "I_Str" # # # User ID# PS2 0000-000000 #************************************ # #Change 1 # #0 ... (Old) line place-holder for reg_log.v1 #1,136 ... 136 (New) lines inserted into reg_log.v2 # + 1: *** Please Read the following information *** + 2: + 3: This file must be viewed from within the SCC VIEW utility. Therefor + 4: start SCC by typing in at the prompt "SCC /v,reg_log.scc" or use SCC + 5: VIEW menu selection. This will bring up the SCC VIEW utility with this + 6: file displayed. Then continue reading the following. + 7: + 8: **** NOTE **** + 9: + 10: The main difference between Shareware Log and a registered Log is + 11: the enhanced view log file "reg_log.scc" and a few extra Log build + 12: options such as "Ignore Strings". The VIEW utility will display this + 13: Log in an enhanced mode. + 14: Please *** NOTE *** this file "reg_log.scc" is just a sample of how + 15: a enhanced registered type Log looks like.. other than that, all the + 16: below principles remain the same for a ShareWare generated Log. + 17: + 18: Invest only 15 minutes of your time, and discover the "Advantage" of + 19: SCC's small CASE utility and its ease of use. This example log file + 20: will review a typical SCC generated change LOG. + 21: + 22: Some of the "LOG" build options set (see above log header) for this + 23: SCC example VIEW utility are set as: + 24: + 25: Group Match = 6 + 26: Log Detail = Yes + 27: Strip End White = No strip ending white space from Old/New + 28: Ignore Case = Yes + 29: Ignore White = Yes + 30: Ignore Numbers = Yes + 31: Ignore Strings = Yes + 32: + 33: String 1 = "I_Str" strings to ignore + 34: String 2 = "Old" + 35: String 3 = "New" + 36: String 4 = "SCC" + 37: String 5 = "CSS" + 38: + 39: If you have a color monitor (for the enhanced view), please note: + 40: + 41: 1) Main "text" screen attributes (foreground/background): + 42: + 43: o CONTROL = High White & Blue Background. + 44: o Old Document = Light White & Blue Background. + 45: o New Document = Yellow & Blue Background. + 46: + 47: 2) Cursor line attributes: + 48: + 49: o Cursor = Black & Cyan Background. + 50: + 51: 3) Left cursor status window attributes: + 52: + 53: o CONTROL = Black & Cyan Background. + 54: o Common Lines = High White & Black Background. + 55: o Old Document = High White & Black Background. + 56: o New Document = Yellow & Black Background. + 57: + 58: 4) Lower left status window attributes: + 59: When any of the above options are set (= Yes) and the SCC log + 60: line cursor position matches a set option or any other condition, + 61: the VIEW status line will indicate same. + 62: + 63: "Ignore Strings " a selected ignore "string" was found. + 64: "Ignore White Sp " white space was ignored between lines. + 65: "Ignore Numbers " numbers was ignored between lines. + 66: "Ignore Case " upper/lower case was considered equal. + 67: "Multi Opt Match" two or more options were necessary to match. + 68: "Moved Line " exact matching lines between documents. + 69: "Common Lines " common lines (with line #) between documents. + 70: "Deleted Line " old line (deleted) from the document. + 71: "Inserted Line " new line (inserted) into the document. + 72: "Close Match " test lines are similar (best guess). + 73: "Range Move " exact matching lines between documents + 74: but in another change group. + 75: + 76: 5) Lower left cursor compare lines window attributes: + 77: + 78: o Cursor = Black & Cyan Background. + 79: + 80: 6) Lower left compare lines window character annotations: + 81: + 82: o Common Lines = High White & Black Background. + 83: o Common Lines = Yellow & Black Background. + 84: + 85: + 86: Note... there are two cursor "tracking" status windows on + 87: the left side of the screen. The status window within the cursor + 88: position will show special symbol that reflects SCC Log control + 89: operations, such characters as '-', '+', '.' or blank ' '. The + 90: status on the lower left of the screen will show what type of + 91: operation SCC "change" control took place. + 92: If the cursor status equals a blank character ' ' the cursor + 93: either will be located either on a SCC Log control line or within + 94: the document text. The following examples will follow only the + 95: cursor position within the SCC Log document text. + 96: + 97: + 98: When the cursor is on a Log line (the left control side) that + 99: has either '-', or '+', then one of the following line operations + 100: will apply. + 101: + 102: + 103: Log status Operation Flip + 104: ---------- --------- ---- + 105: '-' " Deleted Line " No + 106: '+' " Inserted Line " No + 107: '-' or '+' " Close Match " Yes + 108: '-' or '+' " Range Move " Yes + 109: + 110: + 111: When the cursor is on a Log line (the left control side) that + 112: equals a blank character ' 'one of the following line operations + 113: apply. This greatly simplifies the reading of the printed Log, + 114: thus helping to eliminate (unimportant) selected changes. + 115: + 116: + 117: Log status Operation Flip + 118: ---------- --------- ---- + 119: ' ' " Moved Line " Yes + 120: ' ' " Ignore Strings " Yes + 121: ' ' " Ignore White Sp " Yes + 122: ' ' " Ignore Numbers " Yes + 123: ' ' " Ignore Case " Yes + 124: ' ' " Multi Opt Match " Yes + 125: + 126: + 127: When the cursor is on a Log line (the left control side) that + 128: has a period '.', then that line is common to both the files Old + 129: and New. + 130: + 131: + 132: Log status Operation Flip + 133: ---------- --------- ---- + 134: '.' " Common Lines " No New line # shown + 135: + 136: . 137: The above SCC Log status windows (along with different SCC Log . 138: option settings) can help generate a "filtered" SCC change control . 139: report Log to what is important (delete or insert status) and not . 140: important (blank status) in your file. . 141: For example you may not want the '-' or '+' (delete or insert) . 142: Log status characters for such lines containing differences of . 143: only "White Space", "Upper/Lower Case" etc. . 144: . 145: At any time you may press the . 146: F1 key for the help menu. . 147: F2 key for the QUICK help menu. . 148: . 149: . 150: . 151: . 152: START OF EXAMPLES..... # #Change 2 # #17,24 ... 8 (Old) lines deleted from reg_log.v1 #153,156 ... 4 (New) lines inserted into reg_log.v2 # - The following changes without SCC could be extrenely difficult (and - costly) to find. Try fliping between versions(Cnt 'M' key) to help - amplify how a small change could have been ezsley overlooked. - Ww%(123)*(4)[index]A.x,b.7(.Bc)Cd.()*,+|DeEf|FgGh\@$,#&|!\+(0) - " Range Move " - This line is a (Range Move). - " Deleted Lines " - Will show what line and line # that was deleted from the Old. + 153: The following changes without SCC could be extremely difficult (and + 154: costly) to find. Try flipping between versions(Cnt 'V' key) to help + 155: amplify how a small change could have been easily overlooked. + 156: Ww%(123)*(4)[index]A.x,b.7(.Bc)Cd.()*,+|DeEf|FgGh\@$.#&|!\+(0) . 157: " Common Lines " . 158: Common Line numbers between the Old and New documents. Cursor . 159: status will show the corresponding Old line #. . 160: . 161: . 162: . 163: . 164: # #Change 3 # #33,60 ... 28 (Old) lines deleted from reg_log.v1 #165,196 ... 32 (New) lines inserted into reg_log.v2 # " Moved Lines " These are exact matching lines between documents but may have different line numbers. NOTE... whenever the "lower" status window has two line numbers, you can Flip between documents by pressing either Cnt 'V' or Cnt 'M' keys. " Ignore I_Str Strings " All the text match except for selected "strings" between the New and Old documents. " Ignore W h i t e Sp " All the text match e xcept for white space between documents. " IGNORE CASE " All The Text Match Except For UPPER/lower Case between documents. " MULTI I_Str MATCH " All the TEXT match by using Two or more options between the New and Old documents. For example if the option "IGNORE CASE" and "IGNORE string" allowed the I_Str lines match t h e n this status. - " Close Matchs" - Will show what lines and line # that closley matches between - the old & new documents " Ignore Numbers " 654321 All the text match except for numbers between documents. Strip End White If "Strip End White" was selected the following lines will be exactly alike (same length) and would show as "Common Lines". If "Strip End White" was ** NOT ** selected then the lines will be of different lengths. Watch the cursor by flipping (Cnt 'V' or Cnt 'M' keys) between documents. 165: " Ignore Strings " 166: All the text match except for selected "strings" between the Old 167: and New documents. + 168: " Inserted Lines " + 169: Will show what line and line # that was inserted into the New. + 170: " Range Move " + 171: This line is a (Range Move). 172: " Ignore White Sp " 173: All the text match except for white space between documents. 174: " Ignore 1234 Numbers " 175: 4321 All the text match except for numbers 5678between documents. 176: " Ignore Case " 177: All the text match except for upper/lower case between documents. 178: " Multi Match " 179: All the TEXT match by using two or more options between the Old 180: and New documents. For example if the option "Ignore Case" and 181: "Ignore string" allowed the lines match then this status. 182: " Moved Lines " 183: These are exact matching lines between documents but may have 184: different line numbers. NOTE... whenever the "lower" status window 185: has two line numbers, you can Flip between documents by pressing 186: either Cnt 'V' or Cnt 'M' keys. + 187: " Close Match " + 188: Will show what lines and line #'s that closely matches between + 189: the Old/New documents. 190: Strip End White 191: If "Strip End White" was selected the following lines will be 192: exactly alike (same length) and would show as "Common Lines". 193: If "Strip End White" was ** NOT ** selected then the lines 194: will be of different lengths. 195: Watch the cursor by flipping (Cnt 'V' or Cnt 'M' keys) between 196: documents. . 197: Common lines . 198: These lines are common between the Old and New documents. . 199: . 200: ** Note ** SCC can also track and VIEW any (ASCII TEXT) . 201: formatted document such as the following. . 202: . 203: . 204: . 205: . 206: Page 1 Overview.scc . 207: . 208: Software Change Control (SCC) . 209: # #Change 4 # #74,77 ... 4 (Old) lines deleted from reg_log.v1 #210,213 ... 4 (New) lines inserted into reg_log.v2 # - Softtime Systems P.O. Box 2447 - Lk Ronknnkoma LI. NY 11779 - 516 981-8386 + 210: Softime Systems 211: P.O. Box 2447 + 212: Lake Ronkonkoma LI. NY 11779 + 213: (516) 981-8386 . 214: . 215: Copyright (c) 1990-91 by Walter Erickson . 216: All Rights Reserved. . 217: . 218: . 219: "A small CASE for a big problem" # #Change 5 # #84,90 ... 7 (Old) lines deleted from reg_log.v1 #220,231 ... 12 (New) lines inserted into reg_log.v2 # Page 1 OVERVIEW - Questions "about" SCC - What is SCC . - Software Change Control SCC, as the name implies, is one of the most - powerful an cost-effective tool in this energing field of CASE. + 220: Mary J Erickson 221: + 222: + 223: 224: Page 2 225: Overview + 226: Common questions about SCC + 227: + 228: What is SCC ? + 229: ------------- + 230: Software Change Control (SCC), as the name implies, is one of the most + 231: powerful and cost-effective tool available in this emerging field of CASE. . 232: SCC features friendly menu-driven interfaces (with automatic context help) . 233: suitable for use by non-technical administrative, as well as for the . 234: sophisticated user. . 235: . 236: SCC closely tracks (logs) all software/text changes between two similar . 237: source files, thereby giving a complete (version to version) audit trail. . 238: . 239: A SCC generated Log greatly simplifies any user request for the . 240: (identification) of what, when and why changes were made. . 241: # #Change 6 # #101,104 ... 4 (Old) lines deleted from reg_log.v1 #242,245 ... 4 (New) lines inserted into reg_log.v2 # What does CSS do ? ------------------ - When SCC is run the tracking (output) log file will then reflect - (context) what changes have occurred between the two source files, 242: What does SCC do ? 243: ------------------ + 244: When SCC is run the tracking (output) log file will then reflect (in + 245: context) what changes have occurred between the two (input) source files, . 246: thus allowing the programmer and/or management to have a clear visual SCC . 247: log of all software and/or text changes. . 248: . 249: This feature enables the user to control all enhancements and . 250: documentation of source data at this critical level. . 251: . 252: Why is SCC needed ? . 253: ------------------- . 254: All software source files will need changes. In fact, it is a truism that . 255: every software project released, including those released quite recently, . 256: need changes. The most important consideration at this stage is to regulate . 257: and control the documentation and its changes. . 258: . 259: SCC is a decomposition process that offers a complete and precise . 260: description of what (line-by-line) changes have occurred between two source . 261: files. This results in faster development time, along with software that is . 262: far less likely to fail in use. . 263: . 264: Page 3 . 265: Can managers use SCC ? . 266: ---------------------- # #Change 7 # #126,134 ... 9 (Old) lines deleted from reg_log.v1 #267,275 ... 9 (New) lines inserted into reg_log.v2 # Using SCC creates an environment that is very time and cost effective. SCC allows changes to be made in a more maintainable, reliable and controllable way; that is, software control is fully documented, along with a full audit trail of what changes have occurred between software versions. The management of software changes at the programming (source) level (generally accepted as the most expensive and weakest link in software management) is one of the most difficult problems managers and programmers alike have. 267: The management of software changes at the programming (source) level 268: (generally accepted as the most expensive and weakest link in software 269: management) is one of the most difficult problems managers and programmers 270: alike have. 271: 272: Using SCC creates an environment that is very time and cost effective. 273: SCC allows changes to be made in a more maintainable, reliable and 274: controllable way; that is, software control is fully documented, along with 275: a full audit trail of what changes have occurred between software versions. . 276: . 277: SCC greatly improves the suitability and appropriateness of software . 278: change documents; enhances clarity, readability, reliability and complete . 279: recoverability; allowing software changes to be a great deal easier to . 280: track and maintain. . 281: # #Change 8 # #141,146 ... 6 (Old) lines deleted from reg_log.v1 #282,287 ... 6 (New) lines inserted into reg_log.v2 # - Does SCC require a speceal editor ? ----------------------------------- - No, all that's required is that the input source files to CSS be in (Ascii TEXT) format. Does CSS Require a Data Base ? + 282: Does SCC require a special editor ? 283: ----------------------------------- + 284: No, all that is required is that the input source files to SCC be in 285: (ASCII TEXT) format. 286: 287: Does SCC require a data base ? . 288: ------------------------------ . 289: No, SCC can either be integrated into a data base or stand alone, for . 290: most small projects a data base is not necessary, thus eliminating . 291: complexity and cost (KISS). All header file-id, code and documentation . 292: changes "between versions" are kept within the SCC Log itself. . 293: . 294: Can I run SCC against existing versions ? . 295: ----------------------------------------- . 296: Yes, you can build new and complete SCC change logs from older existing . 297: (version to version) files, this will give a entire audit trail of any . 298: software changes between versions. . 299: . 300: What can SCC be used for ? . 301: -------------------------- . 302: o Documenting # #Change 9 # #162,164 ... 3 (Old) lines deleted from reg_log.v1 #303,305 ... 3 (New) lines inserted into reg_log.v2 # - o Software control o Software Debugging - o version pre release (development) change control + 303: o Software/text control 304: o Software Debugging + 305: o version pre-release (development) change control . 306: o Code walkthrough's . 307: o etc. . 308: . 309: Using SCC for Documenting . 310: ------------------------- . 311: When SCC is run, the tracking (output) log file will then reflect (in . 312: context) what changes that have occurred between the two (input) source . 313: files, thus allowing the programmer and/or management to control, enhance . 314: and document software at this critical source level. . 315: . 316: SCC generates a software change (log) that closely tracks and records all . 317: changes consisting of a header, control change numbers and special symbols . 318: to reflect the operations of delete '-', insert '+', move ' ' etc. . 319: # #Change 10 # #179,182 ... 4 (Old) lines deleted from reg_log.v1 #320,323 ... 4 (New) lines inserted into reg_log.v2 # Page 3 Using SCC for Software control ------------------------------ The Manager/Programmer can visually see on one listing (the CHANGE Log) 320: Page 4 321: Using SCC for Software control 322: ------------------------------ 323: The manager/programmer can visually see on one listing (the change log) . 324: all changes and special tracking symbols that were necessary to build the . 325: later version from the earlier version, thus keeping an accurate control . 326: over all changes. . 327: . 328: SCC will also reveal all unintentional and possible unauthorized changes . 329: to source files, thus preventing future problems in the next released . 330: version. . 331: . 332: SCC helps the programmer and manager to make changes, "edit out" any . 333: tactical coding/design errors between two source files. This can be done by . 334: using a similar method such as the following: . 335: . 336: Initial Technical Design Review . 337: o revision of raw draft coding design . 338: o clarification of ambiguous design content . 339: o identification of coding gaps and inconsistencies . 340: o discovery of major/minor coding errors . 341: # #Change 11 # #201,207 ... 7 (Old) lines deleted from reg_log.v1 #342,349 ... 8 (New) lines inserted into reg_log.v2 # - Coding Review - o verification of content NOT already tested or debugged o incorporation of late technical coding changes - o writing specs for changed docunentation Final Technical Design Review - o refining the source code for usability + 342: Quick Coding Review + 343: o verification of technical content NOT already tested or + 344: debugged 345: o incorporation of late technical coding changes + 346: o writing specs for changed documentation 347: 348: Final Technical Design Review + 349: o refining the source code/documentation for usability . 350: o minor "edit" cleanup . 351: o careful configuration control and test proofing . 352: . 353: Field Maintenance of Released Software . 354: o discovery of unintentional coding errors . 355: o discovery of undocumented features . 356: o uncovering code that once worked, but now does not . 357: o SCC Log header information for release identification and control . 358: . 359: Page 5 . 360: SCC summary . 361: ----------- # #Change 12 # #219 ... (Old) line place-holder for reg_log.v1 #362,367 ... 6 (New) lines inserted into reg_log.v2 # + 362: SCC is a comprehensive utility designed to compare two files and generate + 363: various reports (log files) that display any or all change differences as + 364: they evolve. + 365: + 366: SCC log records who, why, when and where changes were made, thus + 367: maintaining a complete history of all changes. . 368: . 369: SCC enables detailed verification of auditing accuracy, eliminates . 370: undetected programming errors and drastically reduces manual desk checking . 371: time. . 372: . 373: The manager/programmer knows exactly what the changes are between . 374: versions. # #Change 13 # #227,230 ... 4 (Old) lines deleted from reg_log.v1 #375,379 ... 5 (New) lines inserted into reg_log.v2 # SCC accepts (ASCII TEXT) output from your favored editor. - SCC is a comprehensive utility designed to compare two files and generate - various reports (log files) that display any or all change differences as - they evolve. + 375: 376: SCC accepts (ASCII TEXT) output from your favored editor. + 377: + 378: You can build new and complete SCC change logs from older existing + 379: (version to version) files. . 380: . 381: You can track any coding progress on software changes by viewing an SCC . 382: log against the previous and/or developing files. . 383: . 384: You can backtrack to any previous version to examine what changes created . 385: that release at that time. . 386: . 387: . 388: SCC change log report (version to version) can greatly help in debugging . 389: changes between versions (one works the other does not). . 390: # #Change 14 # #242,250 ... 9 (Old) lines deleted from reg_log.v1 #391 ... (New) line place-holder for reg_log.v2 # - You can build new and complete SCC change logs from older existing - (version to version) files. - - The key benefits of SCC are: - o lower project costs - o controlled release management - o structured walkthroughs - o faster software coding thruput - o higher software quality . 391: . 392: . 393: ONLY SCC_II "registered" . 394: ------------------------ . 395: You can use the SCC Log to re-create any version (forward or backward), . 396: the SCC header ensures integrity, synchronization and recoverability of the . 397: reconstructed source. . 398: . 399: By using the SCC "short Log" option, you can better utilize disk storage . 400: on your computer. . 401: # #Change 15 # #261 ... (Old) line place-holder for reg_log.v1 #402,407 ... 6 (New) lines inserted into reg_log.v2 # + 402: The key benefits of SCC are: + 403: o lower project costs + 404: o controlled release management + 405: o structured walkthroughs + 406: o faster software coding thruput + 407: o higher software quality . 408: . 409: If you would like further information about this or the SCC registered . 410: programs, please call Walter Erickson at (516) 981-8386 . 411: